Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix for CRD API docs generator #877

Merged
merged 1 commit into from
Jul 8, 2019
Merged

Fix for CRD API docs generator #877

merged 1 commit into from
Jul 8, 2019

Conversation

aLekSer
Copy link
Collaborator

@aLekSer aLekSer commented Jul 5, 2019 •
edited
Loading

Fix CRD API docs generation process.
Leave only one expiryVersion and one publishVersion tag in the resulting doc.

@aLekSer aLekSer mentioned this pull request Jul 5, 2019
Merged
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 5e99d50d-e035-4eac-b65f-6cad9d7ae07e

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/877/head:pr_877 && git checkout pr_877
  • helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=0.12.0-f6688e2

@aLekSer
Copy link
Collaborator Author

aLekSer commented Jul 5, 2019

Wait a moment before merging, found one issue with awk.

@aLekSer aLekSer force-pushed the fix/agones-crd-generator branch from f6688e2 to 3c65906 Compare July 5, 2019 15:24
@aLekSer
Copy link
Collaborator Author

aLekSer commented Jul 5, 2019 •
edited
Loading

Fixed an issue with title extracting. It is needed to have a blank line after the title part:

+++
title="Agones Kubernetes API"
description="Detailed list of Agones Custom Resource Definitions available"
+++

In order to check fast the work of merging part of the script I have commented out generation line and change base_version to 1.0 in Makefile. Also it is needed to change the comments parts of the go files. So that script will actually write new version to the html.
Proven that updates on new releases goes smoothly.

@aLekSer
Copy link
Collaborator Author

aLekSer commented Jul 5, 2019

  1. Algorithm will extract expiryVersion with future Release version say 1.0 (could be empty), publishVersion with any version as it exist in one instance.
  2. All other expiryVersions would be ignored.
  3. Then if something changes in output compared to the previous docs and if version was updated
    1. we mark the old publishVersion=0.12 part as expiryVersion with future Release version 1.0
    2. and all new generated docs goes to publishVersion as 1.0.
  4. If version was not updated:
    1. get the old expiryVersion=1.0 and put as it was
    2. put new docs in publishVersion=1.0 and rewriting all previous contents of the same block
  5. If nothing was changed - no output

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 39073918-9512-46dd-bf94-9eb8e0d19edc

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/877/head:pr_877 && git checkout pr_877
  • helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=0.12.0-3c65906

@aLekSer aLekSer force-pushed the fix/agones-crd-generator branch from 3c65906 to 4c2d6a7 Compare July 5, 2019 15:53
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 1d0e1c6f-9986-4f9c-96ed-dd8e97163cf5

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/877/head:pr_877 && git checkout pr_877
  • helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=0.12.0-4c2d6a7

@aLekSer
Fix for CRD API docs generator
dd969d0 
Leave only one expiryVersion and one publishVersion tag.
@aLekSer aLekSer force-pushed the fix/agones-crd-generator branch from 4c2d6a7 to dd969d0 Compare July 8, 2019 17:11
@agones-bot
Copy link
Collaborator

Build Failed 😱

Build Id: 431a8e79-bd7f-43b8-b067-e0a807c8c300

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

@markmandel markmandel added kind/cleanup Refactoring code, fixing up documentation, etc kind/documentation Documentation for Agones labels Jul 8, 2019
markmandel
markmandel approved these changes Jul 8, 2019
View reviewed changes
Copy link
Member

@markmandel markmandel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

@markmandel markmandel added this to the 0.12.0 milestone Jul 8, 2019
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 668f3592-7452-43b7-9e70-e3300a154f24

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/877/head:pr_877 && git checkout pr_877
  • helm install install/helm/agones --namespace agones-system --name agones --set agones.image.tag=0.12.0-dd969d0

@markmandel markmandel merged commit 9f646bb into googleforgames:master Jul 8, 2019
@aLekSer aLekSer deleted the fix/agones-crd-generator branch July 8, 2019 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markmandel markmandel markmandel approved these changes

Assignees
No one assigned
Labels
kind/cleanup Refactoring code, fixing up documentation, etc kind/documentation Documentation for Agones
Projects
None yet
Milestone
0.12.0
Development

Successfully merging this pull request may close these issues.
3 participants
@aLekSer @agones-bot @markmandel